Platform Explorer / Nuxeo Platform 2021.7

Operation Audit.QueryWithPageProvider (Audit Query With Page Provider)

Description

Perform a query or a named provider query against Audit logs. Result is paginated. The query result will become the input for the next operation. If no query or provider name is given, a query based on default Audit page provider will be executed.
Operation id Audit.QueryWithPageProvider
AliasesAudit.PageProvider
Category Fetch
Label Audit Query With Page Provider
Requires
Since

Parameters

Name Description Type Required Default value
currentPageIndex integer no  
language string no NXQL 
maxResults integer no  
namedQueryParams properties no  
page integer no  
pageSize integer no  
providerName string no  
query string no  
queryParams stringlist no  
sortBy Sort by properties (separated by comma) string no  
sortInfo stringlist no  
sortOrder Sort order, ASC or DESC string no ASC, DESC 

Signature

Inputs void
Outputs paginable

Implementation Information

Implementation Class Class: org.nuxeo.ecm.automation.core.operations.services.AuditPageProviderOperation
Contributing Component org.nuxeo.ecm.core.automation.features.operations

JSON Definition

{
  "id" : "Audit.QueryWithPageProvider",
  "aliases" : [ "Audit.PageProvider" ],
  "label" : "Audit Query With Page Provider",
  "category" : "Fetch",
  "requires" : null,
  "description" : "Perform a query or a named provider query against Audit logs. Result is paginated. The query result will become the input for the next operation. If no query or provider name is given, a query based on default Audit page provider will be executed.",
  "url" : "Audit.QueryWithPageProvider",
  "signature" : [ "void", "paginable" ],
  "params" : [ {
    "name" : "currentPageIndex",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "language",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "NXQL" ]
  }, {
    "name" : "maxResults",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "namedQueryParams",
    "description" : null,
    "type" : "properties",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "page",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "pageSize",
    "description" : null,
    "type" : "integer",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "providerName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "query",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "queryParams",
    "description" : null,
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sortBy",
    "description" : "Sort by properties (separated by comma)",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sortInfo",
    "description" : null,
    "type" : "stringlist",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "sortOrder",
    "description" : "Sort order, ASC or DESC",
    "type" : "string",
    "required" : false,
    "widget" : "Option",
    "order" : 0,
    "values" : [ "ASC", "DESC" ]
  } ]
}